Skip to main content
POST
/
public
/
v1
/
campaign-service
/
campaigns
/
exclusive-banner
[BETA] Create exclusive banner campaign.
curl --request POST \
  --url https://api.topsort.com/public/v1/campaign-service/campaigns/exclusive-banner \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Bola-Bola Ad campaign",
  "isActive": true,
  "externalCampaignId": "<string>",
  "isAutoTrigger": false,
  "startDate": "2023-11-07T05:31:56Z",
  "endDate": "2023-11-07T05:31:56Z",
  "exclusivityPrice": 123,
  "position": 1,
  "walletId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "impressionsThreshold": 123,
  "exclusivityPercentage": 123,
  "bids": [
    {
      "amount": 1,
      "location": "Santiago",
      "target": {
        "id": "p_8983",
        "type": "product"
      },
      "trigger": {
        "type": "<string>",
        "value": {
          "words": [
            "<string>"
          ],
          "matchType": "exact"
        }
      },
      "triggers": [],
      "formatProperties": {
        "bannerAssets": [
          {
            "url": "<string>",
            "contentType": "image/png",
            "dimensions": {
              "width": 1920,
              "height": 1080
            },
            "size": 123,
            "assetId": "asset_01j713j64yfsvtj4bs3ccpy5ca",
            "content": {},
            "jsonTemplateId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
          }
        ],
        "slotId": "<string>",
        "deviceType": "desktop",
        "adFormat": "<string>"
      }
    }
  ],
  "status": "pending",
  "productIds": [
    "<string>"
  ]
}'
{
  "name": "Bola-Bola Ad campaign",
  "isActive": true,
  "externalCampaignId": "<string>",
  "isAutoTrigger": false,
  "marketplaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "campaignId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "startDate": "2023-11-07T05:31:56Z",
  "endDate": "2023-11-07T05:31:56Z",
  "exclusivityPrice": 123,
  "bidType": "exclusive",
  "createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "chargeType": "DAILY",
  "position": 1,
  "campaignType": "manual",
  "status": "pending",
  "adFormat": "exclusive_banner",
  "vendorId": "<string>",
  "impressionsThreshold": 123,
  "exclusivityPercentage": 123,
  "walletId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Authorizations

​
Authorization
string
header
required

Query Parameters

​
vendor_id
string
required
Minimum length: 1

Body

application/json
​
name
string
required
Minimum length: 1
Examples:
​
startDate
string<date-time>
required
​
endDate
string<date-time>
required
​
exclusivityPrice
integer
required
​
bids
BidCreate · object[]
required
Minimum length: 1
​
isActive
boolean
default:true
​
externalCampaignId
string | null
​
isAutoTrigger
boolean
default:false
​
position
integer
default:1
Required range: 1 <= x <= 20
​
walletId
string<uuid> | null
​
impressionsThreshold
integer | null
​
exclusivityPercentage
number | null
​
status
enum<string>
Available options:
approved,
pending,
rejected
​
productIds
string[]
Maximum length: 200

Response

​
name
string
required
Minimum length: 1
Examples:
​
marketplaceId
string<uuid>
required
​
campaignId
string<uuid>
required
​
exclusivityPrice
integer
required
​
chargeType
enum<string>
required
Available options:
DAILY
​
campaignType
enum<string>
required
Available options:
manual,
autobidding,
exclusive
​
adFormat
string
required
Allowed value: "exclusive_banner"
Examples:
​
vendorId
string
required
​
walletId
string<uuid>
required
​
isActive
boolean
default:true
​
externalCampaignId
string | null
​
isAutoTrigger
boolean
default:false
​
startDate
string<date-time>
​
endDate
string<date-time>
​
bidType
string
default:exclusive
Allowed value: "exclusive"
​
createdBy
string<uuid> | null
​
position
integer
default:1
Required range: 1 <= x <= 20
​
status
enum<string>
Available options:
approved,
pending,
rejected
​
impressionsThreshold
integer | null
​
exclusivityPercentage
number | null